/*
 * Copyright (c) 2004-2023, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.scheduling;

import java.util.Date;
import java.util.List;
import javax.annotation.CheckForNull;
import lombok.Data;
import lombok.experimental.Accessors;
import org.hisp.dhis.common.OpenApi;
import org.hisp.dhis.common.UID;
import org.hisp.dhis.user.User;

/**
 * Query params when searching for {@link JobConfiguration}s with errors.
 *
 * <p>A match has to satisfy all filters (AND logic) but only one of the given codes or object
 * {@link UID} (OR logic).
 *
 * <p>If any of the criteria is not defined it has no filter effect.
 *
 * @author Jan Bernitt
 */
@Data
@Accessors(chain = true)
@OpenApi.Property
public class JobRunErrorsParams {

  @OpenApi.Ignore @CheckForNull private UID job;

  /** The user that ran the job */
  @OpenApi.Property({UID.class, User.class})
  @CheckForNull
  private UID user;

  /** The earliest date the job ran that should be included */
  @CheckForNull private Date from;

  /** The latest date the job ran that should be included */
  @CheckForNull private Date to;

  /** The codes to select, any match combined */
  @CheckForNull private List<String> code;

  /** The object with errors to select, any match combined */
  @CheckForNull private List<UID> object;

  /** The {@link JobType} with errors to select, any match combined */
  @CheckForNull private List<JobType> type;

  boolean includeInput = false;
}
